/*
 * Copyright 2011 Clean GWT
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */
package com.cleangwt.page.client;

/**
 * The filter should runs before loading page.
 * 
 * @author Jess
 * @version 1.0
 * @since 1.0
 * @see PageContext
 */
public interface PageFilter {

  /**
   * Filters page.
   * 
   * @param pageName the page name
   * @throws PageFilterException the filter exception may be thrown to break current operation. Use
   *           {@link GWT#setUncaughtExceptionHandler()} to catch this runtime exception and handle
   *           it.
   */
  void doPageFilter(String pageName) throws PageFilterException;
}
